---
layout: docs
page_title: operator usage - Command
description: |-
  "operator usage" produces a report on active clients.
---

> [!IMPORTANT]  
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.

# operator usage

The `operator usage` command allows an administrator to retrieve a
[client count](/vault/docs/concepts/client-count) report
for the default reporting period, or for a specific time range of months.

The command output will list clients by distinct entities, non-entity tokens, ACME clients,
secret sync clients, and total active clients for each namespace, and the total
for the entire cluster. It may indicate that no data is available for the
requested time range, which may be because the client count reporting is
disabled, the time range is too far in the past, or no data has yet been
collected since the feature was enabled.

> Refer to the [Vault Client Usage](/vault/docs/concepts/client-count/client-usage) guide to learn more about usage metrics,
> including required policy and data collection details.

## Examples

Retrieve the client counts for the default reporting period:

```shell-session
$ vault operator usage
Period start: 2019-11-01T00:00:00Z
Period end: 2020-10-31T23:59:59Z

Namespace path   Distinct entities   Non-Entity tokens   Secret syncs   ACME clients   Active clients
--------------   -----------------   -----------------   ------------   ------------   --------------
[root]           1541                332                 40             60             1973

Total            1541                332                 40             60             1973
```

Retrieve the client counts for a specific month in the past:

```shell-session
$ vault operator usage -start-time=2020-01 -end-time=2020-01
Period start: 2020-01-01T00:00:00Z
Period end: 2020-01-31T23:59:59Z

Namespace path   Distinct entities   Non-Entity tokens   Secret syncs   ACME clients   Active clients
--------------   -----------------   -----------------   ------------   ------------   --------------
[root]           934                 176                 20             30             1160

Total            934                 176                 20             30             1160
```

## Usage

The following flags are available in addition to the [standard set of
flags](/vault/docs/commands) included on all commands.

### Output options

- `-format` `(string: "table")` - Print the output in the given format. Valid
  formats are "table", "json", or "yaml". This can also be specified via the
  `VAULT_FORMAT` environment variable.

### Command options

- `-start-time` `(date)` - Start month of the report to generate. May be given as YYYY-MM-DD, YYYY-MM-DD,
  a full RFC3339 timestamp, or a Unix epoch timestamp. Defaults to the billing start date. The [billing start date](/vault/docs/concepts/billing-start-date) automatically rolls over to the latest billing year at the end of the last cycle.

- `-end-time` `(date: previous month)` - End month of the report to generate. Defaults to the end of the current month.

The output shows the exact time range being reported, which may not match the input parameters if a full
month is not available, or if the available reports are a subset of the months requested.
